<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" />
<title>Goblin Camp Developer Guide</title>
<style type="text/css">

/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 6253 2010-03-02 00:24:53Z milde $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin: 0 0 0.5em 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left, .figure.align-left, object.align-left {
  clear: left ;
  float: left ;
  margin-right: 1em }

img.align-right, .figure.align-right, object.align-right {
  clear: right ;
  float: right ;
  margin-left: 1em }

img.align-center, .figure.align-center, object.align-center {
  display: block;
  margin-left: auto;
  margin-right: auto;
}

.align-left {
  text-align: left }

.align-center {
  clear: both ;
  text-align: center }

.align-right {
  text-align: right }

/* reset inner alignment in figures */
div.align-right {
  text-align: left }

/* div.align-center * { */
/*   text-align: left } */

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font: inherit }

pre.literal-block, pre.doctest-block {
  margin-left: 2em ;
  margin-right: 2em }

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document" id="goblin-camp-developer-guide">
<h1 class="title">Goblin Camp Developer Guide</h1>

<!-- vim: set filetype=rst fileencoding=utf-8 expandtab tabstop=4 shiftwidth=4 : -->
<div class="note">
<p class="first admonition-title">Note</p>
<p class="last">This document is a working draft.
All comments are welcome.</p>
</div>
<p>This document describes the Goblin Camp codebase, how it works internally, quirks and gotchas related to modifying the code,
and general guidelines for developers who'd like to contribute.</p>
<!-- This is reStructuredText document. You can build HTML version using rst2html utility -->
<!-- bundled with docutils (http://docutils.sourceforge.net). -->
<div class="contents topic" id="table-of-contents">
<p class="topic-title first">Table of Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#overview-of-the-code-layout" id="id1">Overview of the code layout</a></li>
<li><a class="reference internal" href="#coding-conventions" id="id2">Coding conventions</a></li>
<li><a class="reference internal" href="#handling-external-dependencies" id="id3">Handling external dependencies</a></li>
<li><a class="reference internal" href="#control-flow-in-the-game" id="id4">Control flow in the game</a></li>
<li><a class="reference internal" href="#scripting" id="id5">Scripting</a></li>
<li><a class="reference internal" href="#common-tools" id="id6">Common tools</a></li>
<li><a class="reference internal" href="#saves-class-versioning-and-backwards-compatibility" id="id7">Saves, class versioning and backwards compatibility</a></li>
<li><a class="reference internal" href="#contributing-forums-irc-bitbucket" id="id8">Contributing — forums, IRC, Bitbucket</a></li>
<li><a class="reference internal" href="#applying-for-ci-builders" id="id9">Applying for CI builders</a></li>
</ul>
</div>
<div class="section" id="overview-of-the-code-layout">
<h1><a class="toc-backref" href="#id1">Overview of the code layout</a></h1>
<p>TODO what all those files and directories are.</p>
</div>
<div class="section" id="coding-conventions">
<h1><a class="toc-backref" href="#id2">Coding conventions</a></h1>
<p>TODO indent, naming conventions.</p>
</div>
<div class="section" id="handling-external-dependencies">
<h1><a class="toc-backref" href="#id3">Handling external dependencies</a></h1>
<p>TODO what vendor/ is, how to use new stuff, <tt class="docutils literal">VERSION</tt> and documenting changes, precompiled header.</p>
</div>
<div class="section" id="control-flow-in-the-game">
<h1><a class="toc-backref" href="#id4">Control flow in the game</a></h1>
<p>TODO where do the process start, how to start new game procedurally.</p>
</div>
<div class="section" id="scripting">
<h1><a class="toc-backref" href="#id5">Scripting</a></h1>
<p>TODO how to use and extend the Python bridge.</p>
</div>
<div class="section" id="common-tools">
<h1><a class="toc-backref" href="#id6">Common tools</a></h1>
<p>TODO macros set by the build system, <tt class="docutils literal">GC_ASSERT</tt>, <tt class="docutils literal">GC_DEPRECATED</tt>, <tt class="docutils literal">GC_DEBUG_*</tt>.</p>
</div>
<div class="section" id="saves-class-versioning-and-backwards-compatibility">
<h1><a class="toc-backref" href="#id7">Saves, class versioning and backwards compatibility</a></h1>
<p>TODO how to change save/load members safely.</p>
</div>
<div class="section" id="contributing-forums-irc-bitbucket">
<h1><a class="toc-backref" href="#id8">Contributing — forums, IRC, Bitbucket</a></h1>
<p>TODO creating forks, forum threads for forks, IRC, asking for reviews and sending changes.</p>
</div>
<div class="section" id="applying-for-ci-builders">
<h1><a class="toc-backref" href="#id9">Applying for CI builders</a></h1>
<p>TODO what to do to get Buildbot builder for your fork.</p>
</div>
</div>
</body>
</html>
